figures

What is figures?

The figures npm package provides a set of unicode symbols with fallbacks to ASCII characters for better compatibility across different platforms. It allows developers to enhance the visual appeal and readability of their console output without worrying about cross-platform issues.

What are figures's main functionalities?

Cross-platform symbols

This feature allows the use of symbols like ticks and crosses, with automatic fallbacks to simpler ASCII characters on platforms that do not support the more complex unicode symbols. The code sample demonstrates how to use the tick and cross symbols.

"use strict";\nconst figures = require('figures');\nconsole.log(figures.tick, figures.cross);

Customizable symbol fallbacks

Developers can customize the fallbacks for symbols, providing an alternative character for environments that do not support the default unicode symbol. This code sample shows how to replace the default tick symbol with a custom character.

"use strict";\nconst figures = require('figures');\nfigures.replace({ tick: '√' });\nconsole.log(figures.tick);

Other packages similar to figures

chalk

Chalk is a popular npm package for styling terminal strings. While it focuses on adding color and style to text, figures focuses on providing cross-platform symbols. Both packages enhance the visual output of console applications but in different aspects.

emoji

The emoji package allows for the inclusion of emojis in Node.js applications. Similar to figures, it enhances the visual aspect of console output but does so through emojis rather than symbols. Figures provides a more subtle way of enhancing output with symbols that have fallbacks for better compatibility.

README

figures

Unicode symbols with Windows CMD fallbacks

and more...

Windows CMD only supports a limited character set.

Install

$ npm install figures

Usage

See the source for supported symbols.

const figures = require('figures');

console.log(figures('✔︎ check'));
// On non-Windows OSes:  ✔︎ check
// On Windows:           √ check

console.log(figures.tick);
// On non-Windows OSes:  ✔︎
// On Windows:           √

console.log(figures.main.tick);
// On all OSes:  ✔︎

console.log(figures.windows.tick);
// On all OSes:  √

API

figures(string)

Returns the input with replaced fallback Unicode symbols on Windows.

All the below figures are attached to the main export as shown in the example above.

string

Type: string

String where the Unicode symbols will be replaced with fallback symbols depending on the OS.

figures.main

Symbols to use when not running on Windows.

figures.windows

Symbols to use when running on Windows.

Figures

Name	Non-Windows	Windows
tick	✔	√
cross	✖	×
star	★	*
square	▇	█
squareSmall	◻	[ ]
squareSmallFilled	◼	[█]
play	▶	►
circle	◯	( )
circleFilled	◉	(*)
circleDotted	◌	( )
circleDouble	◎	( )
circleCircle	ⓞ	(○)
circleCross	ⓧ	(×)
circlePipe	Ⓘ	(│)
circleQuestionMark	?⃝	(?)
bullet	●	*
dot	․	.
line	─	─
ellipsis	…	...
pointer	❯	>
pointerSmall	›	»
info	ℹ	i
warning	⚠	‼
hamburger	☰	≡
smiley	㋡	☺
mustache	෴	┌─┐
heart	♥	♥
nodejs	⬢	♦
arrowUp	↑	↑
arrowDown	↓	↓
arrowLeft	←	←
arrowRight	→	→
radioOn	◉	(*)
radioOff	◯	( )
checkboxOn	☒	[×]
checkboxOff	☐	[ ]
checkboxCircleOn	ⓧ	(×)
checkboxCircleOff	Ⓘ	( )
questionMarkPrefix	?⃝	？
oneHalf	½	1/2
oneThird	⅓	1/3
oneQuarter	¼	1/4
oneFifth	⅕	1/5
oneSixth	⅙	1/6
oneSeventh	⅐	1/7
oneEighth	⅛	1/8
oneNinth	⅑	1/9
oneTenth	⅒	1/10
twoThirds	⅔	2/3
twoFifths	⅖	2/5
threeQuarters	¾	3/4
threeFifths	⅗	3/5
threeEighths	⅜	3/8
fourFifths	⅘	4/5
fiveSixths	⅚	5/6
fiveEighths	⅝	5/8
sevenEighths	⅞	7/8

Related

• log-symbols - Colored symbols for various log levels

---

Get professional support for this package with a Tidelift subscription
_{Tidelift helps make open source sustainable for maintainers while giving companies
assurances about security, maintenance, and licensing for their dependencies.}